Skip to content

Conversation

@llucax
Copy link
Contributor

@llucax llucax commented Sep 15, 2023

This new document introduces the actor programming model and how to use it in Frequenz SDK.

Fixes #648.

@llucax llucax requested a review from a team as a code owner September 15, 2023 15:55
@github-actions github-actions bot added part:docs Affects the documentation part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) labels Sep 15, 2023
@llucax
Copy link
Contributor Author

llucax commented Sep 15, 2023

Based on #667, ignore the first 4 commits.

@llucax llucax linked an issue Sep 15, 2023 that may be closed by this pull request
@llucax llucax self-assigned this Sep 15, 2023
Copy link
Contributor

@daniel-zullo-frequenz daniel-zullo-frequenz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a couple of cosmetic comments to check for. LGTM!

@llucax
Copy link
Contributor Author

llucax commented Sep 18, 2023

Did you review all the commits or only what wasn't in #667? If you reviewed everything maybe you can approve #667 too :D

@llucax llucax dismissed daniel-zullo-frequenz’s stale review September 18, 2023 14:38

The merge-base changed after approval.

@llucax llucax dismissed daniel-zullo-frequenz’s stale review September 19, 2023 07:24

The merge-base changed after approval.

This function doesn't need to access the `env` object, so it can be
defined at the top-level.

Signed-off-by: Leandro Lucarella <[email protected]>
This is to encourage users to expand annotations, which might not be
that obvious otherwise.

Signed-off-by: Leandro Lucarella <[email protected]>
This allows to have a read order for annotations.

Signed-off-by: Leandro Lucarella <[email protected]>
This document introduces the actor programming model and how to use it in
Frequenz SDK.

Signed-off-by: Leandro Lucarella <[email protected]>
@llucax llucax dismissed daniel-zullo-frequenz’s stale review September 19, 2023 07:47

The merge-base changed after approval.

@llucax
Copy link
Contributor Author

llucax commented Sep 19, 2023

Investigating an issue with numbered annotations rendering wrongly...

@llucax
Copy link
Contributor Author

llucax commented Sep 19, 2023

Seems to be an upstream bug: squidfunk/mkdocs-material#6042, so I guess we can proceed hoping it will be fixed.

@github-actions github-actions bot removed the part:tooling Affects the development tooling (CI, deployment, dependency management, etc.) label Sep 19, 2023
@llucax llucax enabled auto-merge September 19, 2023 08:31
@llucax llucax disabled auto-merge September 19, 2023 09:02
Copy link
Contributor

@shsms shsms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me, but at some point, we should write additional sections on requirements, best practices, composition patterns, etc.

@llucax
Copy link
Contributor Author

llucax commented Sep 19, 2023

If you have any specific suggestions I can try to add some of that, it is weird, when I'm coding or reading issues I see a lot of things that it would be good to have in docs, but when I sit down to write docs I get a writers block and I don't know what to put in there 😆

@llucax
Copy link
Contributor Author

llucax commented Sep 19, 2023

But I think I will merge this since it is approved so we can keep moving, I can write up any suggestions you make later in a separate PR.

@llucax llucax added this pull request to the merge queue Sep 19, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 19, 2023
@llucax llucax added this pull request to the merge queue Sep 19, 2023
Merged via the queue into frequenz-floss:v0.x.x with commit 9d1f3cd Sep 19, 2023
@llucax llucax deleted the actors-docs branch September 19, 2023 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write a small introduction to actors

3 participants